<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>HSSFWorkbook (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="HSSFWorkbook (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HSSFWorkbook.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFTextbox.html" title="class in org.apache.poi.hssf.usermodel"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hssf/usermodel/HSSFWorkbook.html" target="_top">FRAMES</a></li>
<li><a href="HSSFWorkbook.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.hssf.usermodel</p>
<h2 title="Class HSSFWorkbook" class="title">Class HSSFWorkbook</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">org.apache.poi.POIDocument</a></li>
<li>
<ul class="inheritance">
<li>org.apache.poi.hssf.usermodel.HSSFWorkbook</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></dd>
</dl>
<hr>
<br>
<pre>public final class <strong>HSSFWorkbook</strong>
extends <a href="../../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a>
implements <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></pre>
<div class="block">High level representation of a workbook.  This is the first object most users
 will construct whether they are reading or writing a workbook.  It is also the
 top level object for creating new sheets/etc.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html" title="class in org.apache.poi.hssf.model"><code>InternalWorkbook</code></a>, 
<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel"><code>HSSFSheet</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#_sheets">_sheets</a></strong></code>
<div class="block">this holds the HSSFSheet objects attached to this workbook</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#INITIAL_CAPACITY">INITIAL_CAPACITY</a></strong></code>
<div class="block">used for compile-time performance/memory optimization.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.POIDocument">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></h3>
<code><a href="../../../../../org/apache/poi/POIDocument.html#directory">directory</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.ss.usermodel.Workbook">
<!--   -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.poi.ss.usermodel.<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></h3>
<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_DIB">PICTURE_TYPE_DIB</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_EMF">PICTURE_TYPE_EMF</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_JPEG">PICTURE_TYPE_JPEG</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_PICT">PICTURE_TYPE_PICT</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_PNG">PICTURE_TYPE_PNG</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_WMF">PICTURE_TYPE_WMF</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#SHEET_STATE_HIDDEN">SHEET_STATE_HIDDEN</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#SHEET_STATE_VERY_HIDDEN">SHEET_STATE_VERY_HIDDEN</a>, <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#SHEET_STATE_VISIBLE">SHEET_STATE_VISIBLE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook()">HSSFWorkbook</a></strong>()</code>
<div class="block">Creates new HSSFWorkbook from scratch (start here!)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(org.apache.poi.poifs.filesystem.DirectoryNode, boolean)">HSSFWorkbook</a></strong>(<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;directory,
            boolean&nbsp;preserveNodes)</code>
<div class="block">given a POI POIFSFileSystem object, and a specific directory
  within it, read in its Workbook and populate the high and
  low level models.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(org.apache.poi.poifs.filesystem.DirectoryNode, org.apache.poi.poifs.filesystem.POIFSFileSystem, boolean)">HSSFWorkbook</a></strong>(<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;directory,
            <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;fs,
            boolean&nbsp;preserveNodes)</code>
<div class="block">given a POI POIFSFileSystem object, and a specific directory
  within it, read in its Workbook and populate the high and
  low level models.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(java.io.InputStream)">HSSFWorkbook</a></strong>(java.io.InputStream&nbsp;s)</code>
<div class="block">Companion to HSSFWorkbook(POIFSFileSystem), this constructs the 
  POI filesystem around your inputstream, including all nodes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(java.io.InputStream, boolean)">HSSFWorkbook</a></strong>(java.io.InputStream&nbsp;s,
            boolean&nbsp;preserveNodes)</code>
<div class="block">Companion to HSSFWorkbook(POIFSFileSystem), this constructs the 
 POI filesystem around your inputstream.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(org.apache.poi.poifs.filesystem.POIFSFileSystem)">HSSFWorkbook</a></strong>(<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;fs)</code>
<div class="block">Given a POI POIFSFileSystem object, read in its Workbook along
  with all related nodes, and populate the high and low level models.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(org.apache.poi.poifs.filesystem.POIFSFileSystem, boolean)">HSSFWorkbook</a></strong>(<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;fs,
            boolean&nbsp;preserveNodes)</code>
<div class="block">Given a POI POIFSFileSystem object, read in its Workbook and populate 
 the high and low level models.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#addOlePackage(byte[], java.lang.String, java.lang.String, java.lang.String)">addOlePackage</a></strong>(byte[]&nbsp;oleData,
             java.lang.String&nbsp;label,
             java.lang.String&nbsp;fileName,
             java.lang.String&nbsp;command)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#addOlePackage(org.apache.poi.poifs.filesystem.POIFSFileSystem, java.lang.String, java.lang.String, java.lang.String)">addOlePackage</a></strong>(<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;poiData,
             java.lang.String&nbsp;label,
             java.lang.String&nbsp;fileName,
             java.lang.String&nbsp;command)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#addPicture(byte[], int)">addPicture</a></strong>(byte[]&nbsp;pictureData,
          int&nbsp;format)</code>
<div class="block">Adds a picture to the workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#addSSTString(java.lang.String)">addSSTString</a></strong>(java.lang.String&nbsp;string)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>Do not call this method from your applications. Use the methods
  available in the HSSFRow to add string HSSFCells</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#addToolPack(org.apache.poi.ss.formula.udf.UDFFinder)">addToolPack</a></strong>(<a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a>&nbsp;toopack)</code>
<div class="block">Register a new toolpack in this workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#changeExternalReference(java.lang.String, java.lang.String)">changeExternalReference</a></strong>(java.lang.String&nbsp;oldUrl,
                       java.lang.String&nbsp;newUrl)</code>
<div class="block">Changes an external referenced file to another file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#cloneSheet(int)">cloneSheet</a></strong>(int&nbsp;sheetIndex)</code>
<div class="block">create an HSSFSheet from an existing sheet in the HSSFWorkbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#close()">close</a></strong>()</code>
<div class="block">Closes the underlying <a href="../../../../../org/apache/poi/poifs/filesystem/NPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>NPOIFSFileSystem</code></a> from which
  the Workbook was read, if any.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html" title="class in org.apache.poi.hssf.usermodel">HSSFWorkbook</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#create(org.apache.poi.hssf.model.InternalWorkbook)">create</a></strong>(<a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html" title="class in org.apache.poi.hssf.model">InternalWorkbook</a>&nbsp;book)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFCellStyle.html" title="class in org.apache.poi.hssf.usermodel">HSSFCellStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#createCellStyle()">createCellStyle</a></strong>()</code>
<div class="block">Create a new Cell style and add it to the workbook's style table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFDataFormat.html" title="class in org.apache.poi.hssf.usermodel">HSSFDataFormat</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#createDataFormat()">createDataFormat</a></strong>()</code>
<div class="block">Returns the instance of HSSFDataFormat for this workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFFont.html" title="class in org.apache.poi.hssf.usermodel">HSSFFont</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#createFont()">createFont</a></strong>()</code>
<div class="block">create a new Font and add it to the workbook's font table</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFName.html" title="class in org.apache.poi.hssf.usermodel">HSSFName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#createName()">createName</a></strong>()</code>
<div class="block">creates a new named range and add it to the model</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#createSheet()">createSheet</a></strong>()</code>
<div class="block">create an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns
 the high level representation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#createSheet(java.lang.String)">createSheet</a></strong>(java.lang.String&nbsp;sheetname)</code>
<div class="block">Create a new sheet for this Workbook and return the high level representation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#dumpDrawingGroupRecords(boolean)">dumpDrawingGroupRecords</a></strong>(boolean&nbsp;fat)</code>
<div class="block">Spits out a list of all the drawing records in the workbook.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFFont.html" title="class in org.apache.poi.hssf.usermodel">HSSFFont</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#findFont(short, short, short, java.lang.String, boolean, boolean, short, byte)">findFont</a></strong>(short&nbsp;boldWeight,
        short&nbsp;color,
        short&nbsp;fontHeight,
        java.lang.String&nbsp;name,
        boolean&nbsp;italic,
        boolean&nbsp;strikeout,
        short&nbsp;typeOffset,
        byte&nbsp;underline)</code>
<div class="block">Finds a font that matches the one with the supplied attributes</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#findSheetNameFromExternSheet(int)">findSheetNameFromExternSheet</a></strong>(int&nbsp;externSheetIndex)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>for POI internal use only (formula rendering).  This method is likely to
 be removed in future versions of POI.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getActiveSheetIndex()">getActiveSheetIndex</a></strong>()</code>
<div class="block">gets the tab whose data is actually seen when the sheet is opened.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFObjectData.html" title="class in org.apache.poi.hssf.usermodel">HSSFObjectData</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getAllEmbeddedObjects()">getAllEmbeddedObjects</a></strong>()</code>
<div class="block">Gets all embedded OLE2 objects from the Workbook.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFPictureData.html" title="class in org.apache.poi.hssf.usermodel">HSSFPictureData</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getAllPictures()">getAllPictures</a></strong>()</code>
<div class="block">Gets all pictures from the Workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getBackupFlag()">getBackupFlag</a></strong>()</code>
<div class="block">determine whether the Excel GUI will backup the workbook when saving.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getBytes()">getBytes</a></strong>()</code>
<div class="block">Method getBytes - get the bytes of just the HSSF portions of the XLS file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFCellStyle.html" title="class in org.apache.poi.hssf.usermodel">HSSFCellStyle</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getCellStyleAt(short)">getCellStyleAt</a></strong>(short&nbsp;idx)</code>
<div class="block">get the cell style object at the given index</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFCreationHelper.html" title="class in org.apache.poi.hssf.usermodel">HSSFCreationHelper</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getCreationHelper()">getCreationHelper</a></strong>()</code>
<div class="block">Returns an object that handles instantiating concrete
 classes of the various instances one needs for  HSSF and XSSF.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFPalette.html" title="class in org.apache.poi.hssf.usermodel">HSSFPalette</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getCustomPalette()">getCustomPalette</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getDisplayedTab()">getDisplayedTab</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>- Misleading name - use getFirstVisibleTab()</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getExternalSheetIndex(int)">getExternalSheetIndex</a></strong>(int&nbsp;internalSheetIndex)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>for POI internal use only (formula parsing).  This method is likely to
 be removed in future versions of POI.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getFirstVisibleTab()">getFirstVisibleTab</a></strong>()</code>
<div class="block">sets the first tab that is displayed in the list of tabs in excel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFFont.html" title="class in org.apache.poi.hssf.usermodel">HSSFFont</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getFontAt(short)">getFontAt</a></strong>(short&nbsp;idx)</code>
<div class="block">Get the font at the given index number</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getForceFormulaRecalculation()">getForceFormulaRecalculation</a></strong>()</code>
<div class="block">Whether Excel will be asked to recalculate all formulas when the  workbook is opened.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel">Row.MissingCellPolicy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getMissingCellPolicy()">getMissingCellPolicy</a></strong>()</code>
<div class="block">Retrieves the current policy on what to do when
  getting missing or blank cells from a row.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFName.html" title="class in org.apache.poi.hssf.usermodel">HSSFName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getName(java.lang.String)">getName</a></strong>(java.lang.String&nbsp;name)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFName.html" title="class in org.apache.poi.hssf.usermodel">HSSFName</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getNameAt(int)">getNameAt</a></strong>(int&nbsp;nameIndex)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getNameIndex(java.lang.String)">getNameIndex</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Gets the defined name index by name<br/>
 <i>Note:</i> Excel defined names are case-insensitive and
 this method performs a case-insensitive search.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getNameName(int)">getNameName</a></strong>(int&nbsp;index)</code>
<div class="block">gets the named range name</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getNameRecord(int)">getNameRecord</a></strong>(int&nbsp;nameIndex)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getNumberOfFonts()">getNumberOfFonts</a></strong>()</code>
<div class="block">get the number of fonts in the font table</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getNumberOfNames()">getNumberOfNames</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getNumberOfSheets()">getNumberOfSheets</a></strong>()</code>
<div class="block">get the number of spreadsheets in the workbook (this will be three after serialization)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getNumCellStyles()">getNumCellStyles</a></strong>()</code>
<div class="block">get the number of styles the workbook contains</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static java.util.Map&lt;java.lang.String,<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getOleMap()">getOleMap</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getPrintArea(int)">getPrintArea</a></strong>(int&nbsp;sheetIndex)</code>
<div class="block">Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getRootDirectory()">getRootDirectory</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getSelectedTab()">getSelectedTab</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>- Misleading name - use getActiveSheetIndex()</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getSheet(java.lang.String)">getSheet</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Get sheet with the given name (case insensitive match)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getSheetAt(int)">getSheetAt</a></strong>(int&nbsp;index)</code>
<div class="block">Get the HSSFSheet object at the given index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getSheetIndex(org.apache.poi.ss.usermodel.Sheet)">getSheetIndex</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a>&nbsp;sheet)</code>
<div class="block">Returns the index of the given sheet</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getSheetIndex(java.lang.String)">getSheetIndex</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Returns the index of the sheet by his name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getSheetIndexFromExternSheetIndex(int)">getSheetIndexFromExternSheetIndex</a></strong>(int&nbsp;externSheetNumber)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>for POI internal use only (formula parsing).  This method is likely to
 be removed in future versions of POI.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getSheetName(int)">getSheetName</a></strong>(int&nbsp;sheetIndex)</code>
<div class="block">Get the sheet name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getSSTString(int)">getSSTString</a></strong>(int&nbsp;index)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>Do not call this method from your applications. Use the methods
  available in the HSSFRow to get string HSSFCells</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#getWorkbookDirEntryName(org.apache.poi.poifs.filesystem.DirectoryNode)">getWorkbookDirEntryName</a></strong>(<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;directory)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#insertChartRecord()">insertChartRecord</a></strong>()</code>
<div class="block">Test only.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#isHidden()">isHidden</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#isSheetHidden(int)">isSheetHidden</a></strong>(int&nbsp;sheetIx)</code>
<div class="block">Check whether a sheet is hidden.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#isSheetVeryHidden(int)">isSheetVeryHidden</a></strong>(int&nbsp;sheetIx)</code>
<div class="block">Check whether a sheet is very hidden.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#isWriteProtected()">isWriteProtected</a></strong>()</code>
<div class="block">Is the workbook protected with a password (not encrypted)?</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#linkExternalWorkbook(java.lang.String, org.apache.poi.ss.usermodel.Workbook)">linkExternalWorkbook</a></strong>(java.lang.String&nbsp;name,
                    <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a>&nbsp;workbook)</code>
<div class="block">Adds the LinkTable records required to allow formulas referencing
  the specified external workbook to be added to this one.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#removeName(int)">removeName</a></strong>(int&nbsp;index)</code>
<div class="block">Remove the defined name at the specified index</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#removeName(java.lang.String)">removeName</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Remove a defined name by name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#removePrintArea(int)">removePrintArea</a></strong>(int&nbsp;sheetIndex)</code>
<div class="block">Delete the printarea for the sheet specified</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#removeSheetAt(int)">removeSheetAt</a></strong>(int&nbsp;index)</code>
<div class="block">Removes sheet at the given index.<p/>

 Care must be taken if the removed sheet is the currently active or only selected sheet in
 the workbook.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#resetFontCache()">resetFontCache</a></strong>()</code>
<div class="block">Reset the fonts cache, causing all new calls
  to getFontAt() to create new objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#resolveNameXText(int, int)">resolveNameXText</a></strong>(int&nbsp;refIndex,
                int&nbsp;definedNameIndex)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>for POI internal use only (formula rendering).  This method is likely to
 be removed in future versions of POI.</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setActiveSheet(int)">setActiveSheet</a></strong>(int&nbsp;index)</code>
<div class="block">Convenience method to set the active sheet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setBackupFlag(boolean)">setBackupFlag</a></strong>(boolean&nbsp;backupValue)</code>
<div class="block">determine whether the Excel GUI will backup the workbook when saving.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setDisplayedTab(short)">setDisplayedTab</a></strong>(short&nbsp;index)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>- Misleading name - use setFirstVisibleTab()</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setFirstVisibleTab(int)">setFirstVisibleTab</a></strong>(int&nbsp;index)</code>
<div class="block">sets the first tab that is displayed in the list of tabs
 in excel.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setForceFormulaRecalculation(boolean)">setForceFormulaRecalculation</a></strong>(boolean&nbsp;value)</code>
<div class="block">Whether the application shall perform a full recalculation when the workbook is opened.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setHidden(boolean)">setHidden</a></strong>(boolean&nbsp;hiddenFlag)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy)">setMissingCellPolicy</a></strong>(<a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel">Row.MissingCellPolicy</a>&nbsp;missingCellPolicy)</code>
<div class="block">Sets the policy on what to do when
  getting missing or blank cells from a row.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setPrintArea(int, int, int, int, int)">setPrintArea</a></strong>(int&nbsp;sheetIndex,
            int&nbsp;startColumn,
            int&nbsp;endColumn,
            int&nbsp;startRow,
            int&nbsp;endRow)</code>
<div class="block">For the Convenience of Java Programmers maintaining pointers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setPrintArea(int, java.lang.String)">setPrintArea</a></strong>(int&nbsp;sheetIndex,
            java.lang.String&nbsp;reference)</code>
<div class="block">Sets the printarea for the sheet provided</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setRepeatingRowsAndColumns(int, int, int, int, int)">setRepeatingRowsAndColumns</a></strong>(int&nbsp;sheetIndex,
                          int&nbsp;startColumn,
                          int&nbsp;endColumn,
                          int&nbsp;startRow,
                          int&nbsp;endRow)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>use <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html#setRepeatingRows(org.apache.poi.ss.util.CellRangeAddress)"><code>HSSFSheet.setRepeatingRows(CellRangeAddress)</code></a>
        or <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html#setRepeatingColumns(org.apache.poi.ss.util.CellRangeAddress)"><code>HSSFSheet.setRepeatingColumns(CellRangeAddress)</code></a></i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setSelectedTab(int)">setSelectedTab</a></strong>(int&nbsp;index)</code>
<div class="block">Selects a single sheet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setSelectedTab(short)">setSelectedTab</a></strong>(short&nbsp;index)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>use setSelectedTab(int)</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setSelectedTabs(int[])">setSelectedTabs</a></strong>(int[]&nbsp;indexes)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setSheetHidden(int, boolean)">setSheetHidden</a></strong>(int&nbsp;sheetIx,
              boolean&nbsp;hidden)</code>
<div class="block">Hide or unhide a sheet</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setSheetHidden(int, int)">setSheetHidden</a></strong>(int&nbsp;sheetIx,
              int&nbsp;hidden)</code>
<div class="block">Hide or unhide a sheet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setSheetName(int, java.lang.String)">setSheetName</a></strong>(int&nbsp;sheetIx,
            java.lang.String&nbsp;name)</code>
<div class="block">Set the sheet name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setSheetOrder(java.lang.String, int)">setSheetOrder</a></strong>(java.lang.String&nbsp;sheetname,
             int&nbsp;pos)</code>
<div class="block">sets the order of appearance for a given sheet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#unwriteProtectWorkbook()">unwriteProtectWorkbook</a></strong>()</code>
<div class="block">removes the write protect flag</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#write(java.io.OutputStream)">write</a></strong>(java.io.OutputStream&nbsp;stream)</code>
<div class="block">Method write - write out this workbook to an Outputstream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#writeProtectWorkbook(java.lang.String, java.lang.String)">writeProtectWorkbook</a></strong>(java.lang.String&nbsp;password,
                    java.lang.String&nbsp;username)</code>
<div class="block">protect a workbook with a password (not encypted, just sets writeprotect
 flags and the password.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.POIDocument">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.poi.<a href="../../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></h3>
<code><a href="../../../../../org/apache/poi/POIDocument.html#copyNodeRecursively(org.apache.poi.poifs.filesystem.Entry, org.apache.poi.poifs.filesystem.DirectoryEntry)">copyNodeRecursively</a>, <a href="../../../../../org/apache/poi/POIDocument.html#copyNodes(org.apache.poi.poifs.filesystem.DirectoryNode, org.apache.poi.poifs.filesystem.DirectoryNode, java.util.List)">copyNodes</a>, <a href="../../../../../org/apache/poi/POIDocument.html#copyNodes(org.apache.poi.poifs.filesystem.POIFSFileSystem, org.apache.poi.poifs.filesystem.POIFSFileSystem, java.util.List)">copyNodes</a>, <a href="../../../../../org/apache/poi/POIDocument.html#createInformationProperties()">createInformationProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getDocumentSummaryInformation()">getDocumentSummaryInformation</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getPropertySet(java.lang.String)">getPropertySet</a>, <a href="../../../../../org/apache/poi/POIDocument.html#getSummaryInformation()">getSummaryInformation</a>, <a href="../../../../../org/apache/poi/POIDocument.html#readProperties()">readProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.POIFSFileSystem)">writeProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writeProperties(org.apache.poi.poifs.filesystem.POIFSFileSystem, java.util.List)">writeProperties</a>, <a href="../../../../../org/apache/poi/POIDocument.html#writePropertySet(java.lang.String, org.apache.poi.hpsf.PropertySet, org.apache.poi.poifs.filesystem.POIFSFileSystem)">writePropertySet</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="INITIAL_CAPACITY">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INITIAL_CAPACITY</h4>
<pre>public static final&nbsp;int INITIAL_CAPACITY</pre>
<div class="block">used for compile-time performance/memory optimization.  This determines the
 initial capacity for the sheet collection.  Its currently set to 3.
 Changing it in this release will decrease performance
 since you're never allowed to have more or less than three sheets!</div>
</li>
</ul>
<a name="_sheets">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_sheets</h4>
<pre>protected&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a>&gt; _sheets</pre>
<div class="block">this holds the HSSFSheet objects attached to this workbook</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="HSSFWorkbook()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HSSFWorkbook</h4>
<pre>public&nbsp;HSSFWorkbook()</pre>
<div class="block">Creates new HSSFWorkbook from scratch (start here!)</div>
</li>
</ul>
<a name="HSSFWorkbook(org.apache.poi.poifs.filesystem.POIFSFileSystem)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HSSFWorkbook</h4>
<pre>public&nbsp;HSSFWorkbook(<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;fs)
             throws java.io.IOException</pre>
<div class="block">Given a POI POIFSFileSystem object, read in its Workbook along
  with all related nodes, and populate the high and low level models.
 <p>This calls <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(org.apache.poi.poifs.filesystem.POIFSFileSystem, boolean)"><code>HSSFWorkbook(POIFSFileSystem, boolean)</code></a> with
  preserve nodes set to true.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the stream cannot be read</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(org.apache.poi.poifs.filesystem.POIFSFileSystem, boolean)"><code>HSSFWorkbook(POIFSFileSystem, boolean)</code></a>, 
<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a></dd></dl>
</li>
</ul>
<a name="HSSFWorkbook(org.apache.poi.poifs.filesystem.POIFSFileSystem, boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HSSFWorkbook</h4>
<pre>public&nbsp;HSSFWorkbook(<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;fs,
            boolean&nbsp;preserveNodes)
             throws java.io.IOException</pre>
<div class="block">Given a POI POIFSFileSystem object, read in its Workbook and populate 
 the high and low level models.  If you're reading in a workbook... start here!</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fs</code> - the POI filesystem that contains the Workbook stream.</dd><dd><code>preserveNodes</code> - whether to preseve other nodes, such as
        macros.  This takes more memory, so only say yes if you
        need to. If set, will store all of the POIFSFileSystem
        in memory</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the stream cannot be read</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a></dd></dl>
</li>
</ul>
<a name="HSSFWorkbook(org.apache.poi.poifs.filesystem.DirectoryNode, org.apache.poi.poifs.filesystem.POIFSFileSystem, boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HSSFWorkbook</h4>
<pre>public&nbsp;HSSFWorkbook(<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;directory,
            <a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;fs,
            boolean&nbsp;preserveNodes)
             throws java.io.IOException</pre>
<div class="block">given a POI POIFSFileSystem object, and a specific directory
  within it, read in its Workbook and populate the high and
  low level models.  If you're reading in a workbook...start here.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>directory</code> - the POI filesystem directory to process from</dd><dd><code>fs</code> - the POI filesystem that contains the Workbook stream.</dd><dd><code>preserveNodes</code> - whether to preseve other nodes, such as
        macros.  This takes more memory, so only say yes if you
        need to. If set, will store all of the POIFSFileSystem
        in memory</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the stream cannot be read</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a></dd></dl>
</li>
</ul>
<a name="HSSFWorkbook(org.apache.poi.poifs.filesystem.DirectoryNode, boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HSSFWorkbook</h4>
<pre>public&nbsp;HSSFWorkbook(<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;directory,
            boolean&nbsp;preserveNodes)
             throws java.io.IOException</pre>
<div class="block">given a POI POIFSFileSystem object, and a specific directory
  within it, read in its Workbook and populate the high and
  low level models.  If you're reading in a workbook...start here.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>directory</code> - the POI filesystem directory to process from</dd><dd><code>preserveNodes</code> - whether to preseve other nodes, such as
        macros.  This takes more memory, so only say yes if you
        need to. If set, will store all of the POIFSFileSystem
        in memory</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the stream cannot be read</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a></dd></dl>
</li>
</ul>
<a name="HSSFWorkbook(java.io.InputStream)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HSSFWorkbook</h4>
<pre>public&nbsp;HSSFWorkbook(java.io.InputStream&nbsp;s)
             throws java.io.IOException</pre>
<div class="block">Companion to HSSFWorkbook(POIFSFileSystem), this constructs the 
  POI filesystem around your inputstream, including all nodes.
 <p>This calls <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(java.io.InputStream, boolean)"><code>HSSFWorkbook(InputStream, boolean)</code></a> with
  preserve nodes set to true.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the stream cannot be read</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(java.io.InputStream, boolean)"><code>HSSFWorkbook(InputStream, boolean)</code></a>, 
<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(org.apache.poi.poifs.filesystem.POIFSFileSystem)"><code>HSSFWorkbook(POIFSFileSystem)</code></a>, 
<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a></dd></dl>
</li>
</ul>
<a name="HSSFWorkbook(java.io.InputStream, boolean)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HSSFWorkbook</h4>
<pre>public&nbsp;HSSFWorkbook(java.io.InputStream&nbsp;s,
            boolean&nbsp;preserveNodes)
             throws java.io.IOException</pre>
<div class="block">Companion to HSSFWorkbook(POIFSFileSystem), this constructs the 
 POI filesystem around your inputstream.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>s</code> - the POI filesystem that contains the Workbook stream.</dd><dd><code>preserveNodes</code> - whether to preseve other nodes, such as
        macros.  This takes more memory, so only say yes if you
        need to.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the stream cannot be read</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a>, 
<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#HSSFWorkbook(org.apache.poi.poifs.filesystem.POIFSFileSystem)"><code>HSSFWorkbook(POIFSFileSystem)</code></a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="create(org.apache.poi.hssf.model.InternalWorkbook)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html" title="class in org.apache.poi.hssf.usermodel">HSSFWorkbook</a>&nbsp;create(<a href="../../../../../org/apache/poi/hssf/model/InternalWorkbook.html" title="class in org.apache.poi.hssf.model">InternalWorkbook</a>&nbsp;book)</pre>
</li>
</ul>
<a name="getWorkbookDirEntryName(org.apache.poi.poifs.filesystem.DirectoryNode)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkbookDirEntryName</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getWorkbookDirEntryName(<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;directory)</pre>
</li>
</ul>
<a name="getMissingCellPolicy()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMissingCellPolicy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel">Row.MissingCellPolicy</a>&nbsp;getMissingCellPolicy()</pre>
<div class="block">Retrieves the current policy on what to do when
  getting missing or blank cells from a row.
 The default is to return blank and null cells.
  <a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel"><code>Row.MissingCellPolicy</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getMissingCellPolicy()">getMissingCellPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
</dl>
</li>
</ul>
<a name="setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMissingCellPolicy</h4>
<pre>public&nbsp;void&nbsp;setMissingCellPolicy(<a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel">Row.MissingCellPolicy</a>&nbsp;missingCellPolicy)</pre>
<div class="block">Sets the policy on what to do when
  getting missing or blank cells from a row.
 This will then apply to all calls to
  <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFRow.html#getCell(int)"><code>HSSFRow.getCell(int)</code></a>}. See
  <a href="../../../../../org/apache/poi/ss/usermodel/Row.MissingCellPolicy.html" title="class in org.apache.poi.ss.usermodel"><code>Row.MissingCellPolicy</code></a>.
 Note that this has no effect on any
  iterators, only on when fetching Cells
  by their column index.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy)">setMissingCellPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
</dl>
</li>
</ul>
<a name="setSheetOrder(java.lang.String, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetOrder</h4>
<pre>public&nbsp;void&nbsp;setSheetOrder(java.lang.String&nbsp;sheetname,
                 int&nbsp;pos)</pre>
<div class="block">sets the order of appearance for a given sheet.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetOrder(java.lang.String, int)">setSheetOrder</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetname</code> - the name of the sheet to reorder</dd><dd><code>pos</code> - the position that we want to insert the sheet into (0 based)</dd></dl>
</li>
</ul>
<a name="setSelectedTab(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSelectedTab</h4>
<pre>public&nbsp;void&nbsp;setSelectedTab(int&nbsp;index)</pre>
<div class="block">Selects a single sheet. This may be different to
 the 'active' sheet (which is the sheet with focus).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSelectedTab(int)">setSelectedTab</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the index of the sheet to select (0 based)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html#setSelected(boolean)"><code>Sheet.setSelected(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="setSelectedTab(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSelectedTab</h4>
<pre>@Deprecated
public&nbsp;void&nbsp;setSelectedTab(short&nbsp;index)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use setSelectedTab(int)</i></div>
<div class="block">deprecated May 2008</div>
</li>
</ul>
<a name="setSelectedTabs(int[])">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSelectedTabs</h4>
<pre>public&nbsp;void&nbsp;setSelectedTabs(int[]&nbsp;indexes)</pre>
</li>
</ul>
<a name="setActiveSheet(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setActiveSheet</h4>
<pre>public&nbsp;void&nbsp;setActiveSheet(int&nbsp;index)</pre>
<div class="block">Convenience method to set the active sheet.  The active sheet is is the sheet
 which is currently displayed when the workbook is viewed in Excel.
 'Selected' sheet(s) is a distinct concept.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setActiveSheet(int)">setActiveSheet</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index of the active sheet (0-based)</dd></dl>
</li>
</ul>
<a name="getActiveSheetIndex()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getActiveSheetIndex()</pre>
<div class="block">gets the tab whose data is actually seen when the sheet is opened.
 This may be different from the "selected sheet" since excel seems to
 allow you to show the data of one sheet when another is seen "selected"
 in the tabs (at the bottom).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getActiveSheetIndex()">getActiveSheetIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the index of the active sheet (0-based)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html#setSelected(boolean)"><code>HSSFSheet.setSelected(boolean)</code></a></dd></dl>
</li>
</ul>
<a name="getSelectedTab()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectedTab</h4>
<pre>@Deprecated
public&nbsp;short&nbsp;getSelectedTab()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>- Misleading name - use getActiveSheetIndex()</i></div>
<div class="block">deprecated May 2008</div>
</li>
</ul>
<a name="setFirstVisibleTab(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFirstVisibleTab</h4>
<pre>public&nbsp;void&nbsp;setFirstVisibleTab(int&nbsp;index)</pre>
<div class="block">sets the first tab that is displayed in the list of tabs
 in excel.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setFirstVisibleTab(int)">setFirstVisibleTab</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - </dd></dl>
</li>
</ul>
<a name="setDisplayedTab(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDisplayedTab</h4>
<pre>@Deprecated
public&nbsp;void&nbsp;setDisplayedTab(short&nbsp;index)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>- Misleading name - use setFirstVisibleTab()</i></div>
<div class="block">deprecated May 2008</div>
</li>
</ul>
<a name="getFirstVisibleTab()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFirstVisibleTab</h4>
<pre>public&nbsp;int&nbsp;getFirstVisibleTab()</pre>
<div class="block">sets the first tab that is displayed in the list of tabs in excel.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getFirstVisibleTab()">getFirstVisibleTab</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the first tab that to display in the list of tabs (0-based).</dd></dl>
</li>
</ul>
<a name="getDisplayedTab()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisplayedTab</h4>
<pre>@Deprecated
public&nbsp;short&nbsp;getDisplayedTab()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>- Misleading name - use getFirstVisibleTab()</i></div>
<div class="block">deprecated May 2008</div>
</li>
</ul>
<a name="setSheetName(int, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetName</h4>
<pre>public&nbsp;void&nbsp;setSheetName(int&nbsp;sheetIx,
                java.lang.String&nbsp;name)</pre>
<div class="block">Set the sheet name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetName(int, java.lang.String)">setSheetName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - number (0 based)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the name is null or invalid
  or workbook already contains a sheet with this name</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#createSheet(java.lang.String)"><code>createSheet(String)</code></a>, 
<a href="../../../../../org/apache/poi/ss/util/WorkbookUtil.html#createSafeSheetName(java.lang.String)"><code>WorkbookUtil.createSafeSheetName(String nameProposal)</code></a></dd></dl>
</li>
</ul>
<a name="getSheetName(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getSheetName(int&nbsp;sheetIndex)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetName(int)">Workbook</a></code></strong></div>
<div class="block">Get the sheet name</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetName(int)">getSheetName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - sheet number (0 based)</dd>
<dt><span class="strong">Returns:</span></dt><dd>Sheet name for the specified index</dd></dl>
</li>
</ul>
<a name="isHidden()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHidden</h4>
<pre>public&nbsp;boolean&nbsp;isHidden()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isHidden()">isHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd><code>false</code> if this workbook is not visible in the GUI</dd></dl>
</li>
</ul>
<a name="setHidden(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHidden</h4>
<pre>public&nbsp;void&nbsp;setHidden(boolean&nbsp;hiddenFlag)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setHidden(boolean)">setHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>hiddenFlag</code> - pass <code>false</code> to make the workbook visible in the GUI</dd></dl>
</li>
</ul>
<a name="isSheetHidden(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSheetHidden</h4>
<pre>public&nbsp;boolean&nbsp;isSheetHidden(int&nbsp;sheetIx)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetHidden(int)">Workbook</a></code></strong></div>
<div class="block">Check whether a sheet is hidden.
 <p>
 Note that a sheet could instead be set to be very hidden, which is different
  (<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetVeryHidden(int)"><code>Workbook.isSheetVeryHidden(int)</code></a>)
 </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetHidden(int)">isSheetHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - Number</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if sheet is hidden</dd></dl>
</li>
</ul>
<a name="isSheetVeryHidden(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSheetVeryHidden</h4>
<pre>public&nbsp;boolean&nbsp;isSheetVeryHidden(int&nbsp;sheetIx)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetVeryHidden(int)">Workbook</a></code></strong></div>
<div class="block">Check whether a sheet is very hidden.
 <p>
 This is different from the normal hidden status
  (<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetHidden(int)"><code>Workbook.isSheetHidden(int)</code></a>)
 </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#isSheetVeryHidden(int)">isSheetVeryHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - sheet index to check</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if sheet is very hidden</dd></dl>
</li>
</ul>
<a name="setSheetHidden(int, boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetHidden</h4>
<pre>public&nbsp;void&nbsp;setSheetHidden(int&nbsp;sheetIx,
                  boolean&nbsp;hidden)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetHidden(int, boolean)">Workbook</a></code></strong></div>
<div class="block">Hide or unhide a sheet</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetHidden(int, boolean)">setSheetHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - the sheet index (0-based)</dd><dd><code>hidden</code> - True to mark the sheet as hidden, false otherwise</dd></dl>
</li>
</ul>
<a name="setSheetHidden(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSheetHidden</h4>
<pre>public&nbsp;void&nbsp;setSheetHidden(int&nbsp;sheetIx,
                  int&nbsp;hidden)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetHidden(int, int)">Workbook</a></code></strong></div>
<div class="block">Hide or unhide a sheet.
 
 <ul>
  <li>0 - visible. </li>
  <li>1 - hidden. </li>
  <li>2 - very hidden.</li>
 </ul></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setSheetHidden(int, int)">setSheetHidden</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIx</code> - the sheet index (0-based)</dd><dd><code>hidden</code> - one of the following <code>Workbook</code> constants:
        <code>Workbook.SHEET_STATE_VISIBLE</code>,
        <code>Workbook.SHEET_STATE_HIDDEN</code>, or
        <code>Workbook.SHEET_STATE_VERY_HIDDEN</code>.</dd></dl>
</li>
</ul>
<a name="getSheetIndex(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getSheetIndex(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the index of the sheet by his name</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetIndex(java.lang.String)">getSheetIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the sheet name</dd>
<dt><span class="strong">Returns:</span></dt><dd>index of the sheet (0 based)</dd></dl>
</li>
</ul>
<a name="getSheetIndex(org.apache.poi.ss.usermodel.Sheet)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetIndex</h4>
<pre>public&nbsp;int&nbsp;getSheetIndex(<a href="../../../../../org/apache/poi/ss/usermodel/Sheet.html" title="interface in org.apache.poi.ss.usermodel">Sheet</a>&nbsp;sheet)</pre>
<div class="block">Returns the index of the given sheet</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetIndex(org.apache.poi.ss.usermodel.Sheet)">getSheetIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheet</code> - the sheet to look up</dd>
<dt><span class="strong">Returns:</span></dt><dd>index of the sheet (0 based). <tt>-1</tt> if not found</dd></dl>
</li>
</ul>
<a name="getExternalSheetIndex(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalSheetIndex</h4>
<pre>@Deprecated
public&nbsp;int&nbsp;getExternalSheetIndex(int&nbsp;internalSheetIndex)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>for POI internal use only (formula parsing).  This method is likely to
 be removed in future versions of POI.</i></div>
<div class="block">Returns the external sheet index of the sheet
  with the given internal index, creating one
  if needed.
 Used by some of the more obscure formula and
  named range things.</div>
</li>
</ul>
<a name="findSheetNameFromExternSheet(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findSheetNameFromExternSheet</h4>
<pre>@Deprecated
public&nbsp;java.lang.String&nbsp;findSheetNameFromExternSheet(int&nbsp;externSheetIndex)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>for POI internal use only (formula rendering).  This method is likely to
 be removed in future versions of POI.</i></div>
</li>
</ul>
<a name="resolveNameXText(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveNameXText</h4>
<pre>@Deprecated
public&nbsp;java.lang.String&nbsp;resolveNameXText(int&nbsp;refIndex,
                                           int&nbsp;definedNameIndex)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>for POI internal use only (formula rendering).  This method is likely to
 be removed in future versions of POI.</i></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>refIndex</code> - Index to REF entry in EXTERNSHEET record in the Link Table</dd><dd><code>definedNameIndex</code> - zero-based to DEFINEDNAME or EXTERNALNAME record</dd>
<dt><span class="strong">Returns:</span></dt><dd>the string representation of the defined or external name</dd></dl>
</li>
</ul>
<a name="createSheet()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSheet</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a>&nbsp;createSheet()</pre>
<div class="block">create an HSSFSheet for this HSSFWorkbook, adds it to the sheets and returns
 the high level representation.  Use this to create new sheets.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createSheet()">createSheet</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>HSSFSheet representing the new sheet.</dd></dl>
</li>
</ul>
<a name="cloneSheet(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneSheet</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a>&nbsp;cloneSheet(int&nbsp;sheetIndex)</pre>
<div class="block">create an HSSFSheet from an existing sheet in the HSSFWorkbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#cloneSheet(int)">cloneSheet</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>HSSFSheet representing the cloned sheet.</dd></dl>
</li>
</ul>
<a name="createSheet(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSheet</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a>&nbsp;createSheet(java.lang.String&nbsp;sheetname)</pre>
<div class="block">Create a new sheet for this Workbook and return the high level representation.
 Use this to create new sheets.

 <p>
     Note that Excel allows sheet names up to 31 chars in length but other applications
     (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars,
     others - truncate such names to 31 character.
 </p>
 <p>
     POI's SpreadsheetAPI silently truncates the input argument to 31 characters.
     Example:

     <pre><code>
     Sheet sheet = workbook.createSheet("My very long sheet name which is longer than 31 chars"); // will be truncated
     assert 31 == sheet.getSheetName().length();
     assert "My very long sheet name which i" == sheet.getSheetName();
     </code></pre>
 </p>

 Except the 31-character constraint, Excel applies some other rules:
 <p>
 Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:
 <ul>
 <li> 0x0000 </li>
 <li> 0x0003 </li>
 <li> colon (:) </li>
 <li> backslash (\) </li>
 <li> asterisk (*) </li>
 <li> question mark (?) </li>
 <li> forward slash (/) </li>
 <li> opening square bracket ([) </li>
 <li> closing square bracket (]) </li>
 </ul>
 The string MUST NOT begin or end with the single quote (') character.
 </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createSheet(java.lang.String)">createSheet</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetname</code> - sheetname to set for the sheet.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Sheet representing the new sheet.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the name is null or invalid
  or workbook already contains a sheet with this name</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/util/WorkbookUtil.html#createSafeSheetName(java.lang.String)"><code>WorkbookUtil.createSafeSheetName(String nameProposal)</code></a></dd></dl>
</li>
</ul>
<a name="getNumberOfSheets()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfSheets</h4>
<pre>public&nbsp;int&nbsp;getNumberOfSheets()</pre>
<div class="block">get the number of spreadsheets in the workbook (this will be three after serialization)</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNumberOfSheets()">getNumberOfSheets</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>number of sheets</dd></dl>
</li>
</ul>
<a name="getSheetIndexFromExternSheetIndex(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetIndexFromExternSheetIndex</h4>
<pre>@Deprecated
public&nbsp;int&nbsp;getSheetIndexFromExternSheetIndex(int&nbsp;externSheetNumber)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>for POI internal use only (formula parsing).  This method is likely to
 be removed in future versions of POI.</i></div>
</li>
</ul>
<a name="getSheetAt(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheetAt</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a>&nbsp;getSheetAt(int&nbsp;index)</pre>
<div class="block">Get the HSSFSheet object at the given index.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheetAt(int)">getSheetAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - of the sheet number (0-based physical & logical)</dd>
<dt><span class="strong">Returns:</span></dt><dd>HSSFSheet at the provided index</dd></dl>
</li>
</ul>
<a name="getSheet(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSheet</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html" title="class in org.apache.poi.hssf.usermodel">HSSFSheet</a>&nbsp;getSheet(java.lang.String&nbsp;name)</pre>
<div class="block">Get sheet with the given name (case insensitive match)</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getSheet(java.lang.String)">getSheet</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - of the sheet</dd>
<dt><span class="strong">Returns:</span></dt><dd>HSSFSheet with the name provided or <code>null</code> if it does not exist</dd></dl>
</li>
</ul>
<a name="removeSheetAt(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSheetAt</h4>
<pre>public&nbsp;void&nbsp;removeSheetAt(int&nbsp;index)</pre>
<div class="block">Removes sheet at the given index.<p/>

 Care must be taken if the removed sheet is the currently active or only selected sheet in
 the workbook. There are a few situations when Excel must have a selection and/or active
 sheet. (For example when printing - see Bug 40414).<br/>

 This method makes sure that if the removed sheet was active, another sheet will become
 active in its place.  Furthermore, if the removed sheet was the only selected sheet, another
 sheet will become selected.  The newly active/selected sheet will have the same index, or
 one less if the removed sheet was the last in the workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeSheetAt(int)">removeSheetAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - of the sheet  (0-based)</dd></dl>
</li>
</ul>
<a name="setBackupFlag(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBackupFlag</h4>
<pre>public&nbsp;void&nbsp;setBackupFlag(boolean&nbsp;backupValue)</pre>
<div class="block">determine whether the Excel GUI will backup the workbook when saving.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>backupValue</code> - true to indicate a backup will be performed.</dd></dl>
</li>
</ul>
<a name="getBackupFlag()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBackupFlag</h4>
<pre>public&nbsp;boolean&nbsp;getBackupFlag()</pre>
<div class="block">determine whether the Excel GUI will backup the workbook when saving.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current setting for backups.</dd></dl>
</li>
</ul>
<a name="setRepeatingRowsAndColumns(int, int, int, int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRepeatingRowsAndColumns</h4>
<pre>@Deprecated
public&nbsp;void&nbsp;setRepeatingRowsAndColumns(int&nbsp;sheetIndex,
                                         int&nbsp;startColumn,
                                         int&nbsp;endColumn,
                                         int&nbsp;startRow,
                                         int&nbsp;endRow)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html#setRepeatingRows(org.apache.poi.ss.util.CellRangeAddress)"><code>HSSFSheet.setRepeatingRows(CellRangeAddress)</code></a>
        or <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFSheet.html#setRepeatingColumns(org.apache.poi.ss.util.CellRangeAddress)"><code>HSSFSheet.setRepeatingColumns(CellRangeAddress)</code></a></i></div>
<div class="block">Sets the repeating rows and columns for a sheet (as found in
 2003:File->PageSetup->Sheet, 2007:Page Layout->Print Titles).
   This is function is included in the workbook
 because it creates/modifies name records which are stored at the
 workbook level.
 <p>
 To set just repeating columns:
 <pre>
  workbook.setRepeatingRowsAndColumns(0,0,1,-1-1);
 </pre>
 To set just repeating rows:
 <pre>
  workbook.setRepeatingRowsAndColumns(0,-1,-1,0,4);
 </pre>
 To remove all repeating rows and columns for a sheet.
 <pre>
  workbook.setRepeatingRowsAndColumns(0,-1,-1,-1,-1);
 </pre></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setRepeatingRowsAndColumns(int, int, int, int, int)">setRepeatingRowsAndColumns</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - 0 based index to sheet.</dd><dd><code>startColumn</code> - 0 based start of repeating columns.</dd><dd><code>endColumn</code> - 0 based end of repeating columns.</dd><dd><code>startRow</code> - 0 based start of repeating rows.</dd><dd><code>endRow</code> - 0 based end of repeating rows.</dd></dl>
</li>
</ul>
<a name="createFont()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFont</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFFont.html" title="class in org.apache.poi.hssf.usermodel">HSSFFont</a>&nbsp;createFont()</pre>
<div class="block">create a new Font and add it to the workbook's font table</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createFont()">createFont</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>new font object</dd></dl>
</li>
</ul>
<a name="findFont(short, short, short, java.lang.String, boolean, boolean, short, byte)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findFont</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFFont.html" title="class in org.apache.poi.hssf.usermodel">HSSFFont</a>&nbsp;findFont(short&nbsp;boldWeight,
                short&nbsp;color,
                short&nbsp;fontHeight,
                java.lang.String&nbsp;name,
                boolean&nbsp;italic,
                boolean&nbsp;strikeout,
                short&nbsp;typeOffset,
                byte&nbsp;underline)</pre>
<div class="block">Finds a font that matches the one with the supplied attributes</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#findFont(short, short, short, java.lang.String, boolean, boolean, short, byte)">findFont</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the font with the matched attributes or <code>null</code></dd></dl>
</li>
</ul>
<a name="getNumberOfFonts()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfFonts</h4>
<pre>public&nbsp;short&nbsp;getNumberOfFonts()</pre>
<div class="block">get the number of fonts in the font table</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNumberOfFonts()">getNumberOfFonts</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>number of fonts</dd></dl>
</li>
</ul>
<a name="getFontAt(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFontAt</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFFont.html" title="class in org.apache.poi.hssf.usermodel">HSSFFont</a>&nbsp;getFontAt(short&nbsp;idx)</pre>
<div class="block">Get the font at the given index number</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getFontAt(short)">getFontAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>idx</code> - index number</dd>
<dt><span class="strong">Returns:</span></dt><dd>HSSFFont at the index</dd></dl>
</li>
</ul>
<a name="resetFontCache()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetFontCache</h4>
<pre>protected&nbsp;void&nbsp;resetFontCache()</pre>
<div class="block">Reset the fonts cache, causing all new calls
  to getFontAt() to create new objects.
 Should only be called after deleting fonts,
  and that's not something you should normally do</div>
</li>
</ul>
<a name="createCellStyle()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createCellStyle</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFCellStyle.html" title="class in org.apache.poi.hssf.usermodel">HSSFCellStyle</a>&nbsp;createCellStyle()</pre>
<div class="block">Create a new Cell style and add it to the workbook's style table.
 You can define up to 4000 unique styles in a .xls workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createCellStyle()">createCellStyle</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the new Cell Style object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the maximum number of cell styles exceeded the limit</dd></dl>
</li>
</ul>
<a name="getNumCellStyles()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumCellStyles</h4>
<pre>public&nbsp;short&nbsp;getNumCellStyles()</pre>
<div class="block">get the number of styles the workbook contains</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNumCellStyles()">getNumCellStyles</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>count of cell styles</dd></dl>
</li>
</ul>
<a name="getCellStyleAt(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCellStyleAt</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFCellStyle.html" title="class in org.apache.poi.hssf.usermodel">HSSFCellStyle</a>&nbsp;getCellStyleAt(short&nbsp;idx)</pre>
<div class="block">get the cell style object at the given index</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getCellStyleAt(short)">getCellStyleAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>idx</code> - index within the set of styles</dd>
<dt><span class="strong">Returns:</span></dt><dd>HSSFCellStyle object at the index</dd></dl>
</li>
</ul>
<a name="close()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
           throws java.io.IOException</pre>
<div class="block">Closes the underlying <a href="../../../../../org/apache/poi/poifs/filesystem/NPOIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>NPOIFSFileSystem</code></a> from which
  the Workbook was read, if any. Has no effect on Workbooks
  opened from an InputStream, or newly created ones.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="write(java.io.OutputStream)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre>public&nbsp;void&nbsp;write(java.io.OutputStream&nbsp;stream)
           throws java.io.IOException</pre>
<div class="block">Method write - write out this workbook to an Outputstream.  Constructs
 a new POI POIFSFileSystem, passes in the workbook binary representation  and
 writes it out.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#write(java.io.OutputStream)">write</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/POIDocument.html#write(java.io.OutputStream)">write</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/poi/POIDocument.html" title="class in org.apache.poi">POIDocument</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - - the java OutputStream you wish to write the XLS to</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if anything can't be written.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem"><code>POIFSFileSystem</code></a></dd></dl>
</li>
</ul>
<a name="getBytes()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public&nbsp;byte[]&nbsp;getBytes()</pre>
<div class="block">Method getBytes - get the bytes of just the HSSF portions of the XLS file.
 Use this to construct a POI POIFSFileSystem yourself.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>byte[] array containing the binary representation of this workbook and all contained
         sheets, rows, cells, etc.</dd></dl>
</li>
</ul>
<a name="addSSTString(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSSTString</h4>
<pre>@Deprecated
public&nbsp;int&nbsp;addSSTString(java.lang.String&nbsp;string)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>Do not call this method from your applications. Use the methods
  available in the HSSFRow to add string HSSFCells</i></div>
</li>
</ul>
<a name="getSSTString(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSSTString</h4>
<pre>@Deprecated
public&nbsp;java.lang.String&nbsp;getSSTString(int&nbsp;index)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>Do not call this method from your applications. Use the methods
  available in the HSSFRow to get string HSSFCells</i></div>
</li>
</ul>
<a name="getNumberOfNames()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumberOfNames</h4>
<pre>public&nbsp;int&nbsp;getNumberOfNames()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNumberOfNames()">getNumberOfNames</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the total number of defined names in this workbook</dd></dl>
</li>
</ul>
<a name="getName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFName.html" title="class in org.apache.poi.hssf.usermodel">HSSFName</a>&nbsp;getName(java.lang.String&nbsp;name)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getName(java.lang.String)">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the defined name</dd>
<dt><span class="strong">Returns:</span></dt><dd>the defined name with the specified name. <code>null</code> if not found.</dd></dl>
</li>
</ul>
<a name="getNameAt(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameAt</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFName.html" title="class in org.apache.poi.hssf.usermodel">HSSFName</a>&nbsp;getNameAt(int&nbsp;nameIndex)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNameAt(int)">getNameAt</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>nameIndex</code> - position of the named range (0-based)</dd>
<dt><span class="strong">Returns:</span></dt><dd>the defined name at the specified index</dd></dl>
</li>
</ul>
<a name="getNameRecord(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameRecord</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/record/NameRecord.html" title="class in org.apache.poi.hssf.record">NameRecord</a>&nbsp;getNameRecord(int&nbsp;nameIndex)</pre>
</li>
</ul>
<a name="getNameName(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getNameName(int&nbsp;index)</pre>
<div class="block">gets the named range name</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - the named range index (0 based)</dd>
<dt><span class="strong">Returns:</span></dt><dd>named range name</dd></dl>
</li>
</ul>
<a name="setPrintArea(int, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPrintArea</h4>
<pre>public&nbsp;void&nbsp;setPrintArea(int&nbsp;sheetIndex,
                java.lang.String&nbsp;reference)</pre>
<div class="block">Sets the printarea for the sheet provided
 <p>
 i.e. Reference = $A$1:$B$2</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setPrintArea(int, java.lang.String)">setPrintArea</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</dd><dd><code>reference</code> - Valid name Reference for the Print Area</dd></dl>
</li>
</ul>
<a name="setPrintArea(int, int, int, int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPrintArea</h4>
<pre>public&nbsp;void&nbsp;setPrintArea(int&nbsp;sheetIndex,
                int&nbsp;startColumn,
                int&nbsp;endColumn,
                int&nbsp;startRow,
                int&nbsp;endRow)</pre>
<div class="block">For the Convenience of Java Programmers maintaining pointers.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setPrintArea(int, int, int, int, int)">setPrintArea</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - Zero-based sheet index (0 = First Sheet)</dd><dd><code>startColumn</code> - Column to begin printarea</dd><dd><code>endColumn</code> - Column to end the printarea</dd><dd><code>startRow</code> - Row to begin the printarea</dd><dd><code>endRow</code> - Row to end the printarea</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFWorkbook.html#setPrintArea(int, java.lang.String)"><code>setPrintArea(int, String)</code></a></dd></dl>
</li>
</ul>
<a name="getPrintArea(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrintArea</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPrintArea(int&nbsp;sheetIndex)</pre>
<div class="block">Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getPrintArea(int)">getPrintArea</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</dd>
<dt><span class="strong">Returns:</span></dt><dd>String Null if no print area has been defined</dd></dl>
</li>
</ul>
<a name="removePrintArea(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removePrintArea</h4>
<pre>public&nbsp;void&nbsp;removePrintArea(int&nbsp;sheetIndex)</pre>
<div class="block">Delete the printarea for the sheet specified</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removePrintArea(int)">removePrintArea</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>sheetIndex</code> - Zero-based sheet index (0 = First Sheet)</dd></dl>
</li>
</ul>
<a name="createName()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createName</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFName.html" title="class in org.apache.poi.hssf.usermodel">HSSFName</a>&nbsp;createName()</pre>
<div class="block">creates a new named range and add it to the model</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createName()">createName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>named range high level</dd></dl>
</li>
</ul>
<a name="getNameIndex(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameIndex</h4>
<pre>public&nbsp;int&nbsp;getNameIndex(java.lang.String&nbsp;name)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNameIndex(java.lang.String)">Workbook</a></code></strong></div>
<div class="block">Gets the defined name index by name<br/>
 <i>Note:</i> Excel defined names are case-insensitive and
 this method performs a case-insensitive search.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getNameIndex(java.lang.String)">getNameIndex</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the defined name</dd>
<dt><span class="strong">Returns:</span></dt><dd>zero based index of the defined name. <tt>-1</tt> if not found.</dd></dl>
</li>
</ul>
<a name="removeName(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeName</h4>
<pre>public&nbsp;void&nbsp;removeName(int&nbsp;index)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(int)">Workbook</a></code></strong></div>
<div class="block">Remove the defined name at the specified index</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(int)">removeName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - named range index (0 based)</dd></dl>
</li>
</ul>
<a name="createDataFormat()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDataFormat</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFDataFormat.html" title="class in org.apache.poi.hssf.usermodel">HSSFDataFormat</a>&nbsp;createDataFormat()</pre>
<div class="block">Returns the instance of HSSFDataFormat for this workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#createDataFormat()">createDataFormat</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the HSSFDataFormat object</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/hssf/record/FormatRecord.html" title="class in org.apache.poi.hssf.record"><code>FormatRecord</code></a>, 
<a href="../../../../../org/apache/poi/hssf/record/Record.html" title="class in org.apache.poi.hssf.record"><code>Record</code></a></dd></dl>
</li>
</ul>
<a name="removeName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeName</h4>
<pre>public&nbsp;void&nbsp;removeName(java.lang.String&nbsp;name)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(java.lang.String)">Workbook</a></code></strong></div>
<div class="block">Remove a defined name by name</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#removeName(java.lang.String)">removeName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the defined name</dd></dl>
</li>
</ul>
<a name="getCustomPalette()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCustomPalette</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFPalette.html" title="class in org.apache.poi.hssf.usermodel">HSSFPalette</a>&nbsp;getCustomPalette()</pre>
</li>
</ul>
<a name="insertChartRecord()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertChartRecord</h4>
<pre>public&nbsp;void&nbsp;insertChartRecord()</pre>
<div class="block">Test only. Do not use</div>
</li>
</ul>
<a name="dumpDrawingGroupRecords(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dumpDrawingGroupRecords</h4>
<pre>public&nbsp;void&nbsp;dumpDrawingGroupRecords(boolean&nbsp;fat)</pre>
<div class="block">Spits out a list of all the drawing records in the workbook.</div>
</li>
</ul>
<a name="addPicture(byte[], int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPicture</h4>
<pre>public&nbsp;int&nbsp;addPicture(byte[]&nbsp;pictureData,
             int&nbsp;format)</pre>
<div class="block">Adds a picture to the workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#addPicture(byte[], int)">addPicture</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>pictureData</code> - The bytes of the picture</dd><dd><code>format</code> - The format of the picture.  One of <code>PICTURE_TYPE_*</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the index to this picture (1 based).</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_EMF"><code>Workbook.PICTURE_TYPE_EMF</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_WMF"><code>Workbook.PICTURE_TYPE_WMF</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_PICT"><code>Workbook.PICTURE_TYPE_PICT</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_JPEG"><code>Workbook.PICTURE_TYPE_JPEG</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_PNG"><code>Workbook.PICTURE_TYPE_PNG</code></a>, 
<a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#PICTURE_TYPE_DIB"><code>Workbook.PICTURE_TYPE_DIB</code></a></dd></dl>
</li>
</ul>
<a name="getAllPictures()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllPictures</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFPictureData.html" title="class in org.apache.poi.hssf.usermodel">HSSFPictureData</a>&gt;&nbsp;getAllPictures()</pre>
<div class="block">Gets all pictures from the Workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getAllPictures()">getAllPictures</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the list of pictures (a list of <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFPictureData.html" title="class in org.apache.poi.hssf.usermodel"><code>HSSFPictureData</code></a> objects.)</dd></dl>
</li>
</ul>
<a name="getOleMap()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOleMap</h4>
<pre>protected static&nbsp;java.util.Map&lt;java.lang.String,<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a>&gt;&nbsp;getOleMap()</pre>
</li>
</ul>
<a name="addOlePackage(org.apache.poi.poifs.filesystem.POIFSFileSystem, java.lang.String, java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOlePackage</h4>
<pre>public&nbsp;int&nbsp;addOlePackage(<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;poiData,
                java.lang.String&nbsp;label,
                java.lang.String&nbsp;fileName,
                java.lang.String&nbsp;command)
                  throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="addOlePackage(byte[], java.lang.String, java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOlePackage</h4>
<pre>public&nbsp;int&nbsp;addOlePackage(byte[]&nbsp;oleData,
                java.lang.String&nbsp;label,
                java.lang.String&nbsp;fileName,
                java.lang.String&nbsp;command)
                  throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="linkExternalWorkbook(java.lang.String, org.apache.poi.ss.usermodel.Workbook)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>linkExternalWorkbook</h4>
<pre>public&nbsp;int&nbsp;linkExternalWorkbook(java.lang.String&nbsp;name,
                       <a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a>&nbsp;workbook)</pre>
<div class="block">Adds the LinkTable records required to allow formulas referencing
  the specified external workbook to be added to this one. Allows
  formulas such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the 
  file, for workbooks not already referenced.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#linkExternalWorkbook(java.lang.String, org.apache.poi.ss.usermodel.Workbook)">linkExternalWorkbook</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name the workbook will be referenced as in formulas</dd><dd><code>workbook</code> - The open workbook to fetch the link required information from</dd></dl>
</li>
</ul>
<a name="isWriteProtected()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWriteProtected</h4>
<pre>public&nbsp;boolean&nbsp;isWriteProtected()</pre>
<div class="block">Is the workbook protected with a password (not encrypted)?</div>
</li>
</ul>
<a name="writeProtectWorkbook(java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeProtectWorkbook</h4>
<pre>public&nbsp;void&nbsp;writeProtectWorkbook(java.lang.String&nbsp;password,
                        java.lang.String&nbsp;username)</pre>
<div class="block">protect a workbook with a password (not encypted, just sets writeprotect
 flags and the password.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>password</code> - to set</dd></dl>
</li>
</ul>
<a name="unwriteProtectWorkbook()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unwriteProtectWorkbook</h4>
<pre>public&nbsp;void&nbsp;unwriteProtectWorkbook()</pre>
<div class="block">removes the write protect flag</div>
</li>
</ul>
<a name="getAllEmbeddedObjects()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllEmbeddedObjects</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFObjectData.html" title="class in org.apache.poi.hssf.usermodel">HSSFObjectData</a>&gt;&nbsp;getAllEmbeddedObjects()</pre>
<div class="block">Gets all embedded OLE2 objects from the Workbook.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the list of embedded objects (a list of <a href="../../../../../org/apache/poi/hssf/usermodel/HSSFObjectData.html" title="class in org.apache.poi.hssf.usermodel"><code>HSSFObjectData</code></a> objects.)</dd></dl>
</li>
</ul>
<a name="getCreationHelper()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreationHelper</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/hssf/usermodel/HSSFCreationHelper.html" title="class in org.apache.poi.hssf.usermodel">HSSFCreationHelper</a>&nbsp;getCreationHelper()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getCreationHelper()">Workbook</a></code></strong></div>
<div class="block">Returns an object that handles instantiating concrete
 classes of the various instances one needs for  HSSF and XSSF.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getCreationHelper()">getCreationHelper</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
</dl>
</li>
</ul>
<a name="addToolPack(org.apache.poi.ss.formula.udf.UDFFinder)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToolPack</h4>
<pre>public&nbsp;void&nbsp;addToolPack(<a href="../../../../../org/apache/poi/ss/formula/udf/UDFFinder.html" title="interface in org.apache.poi.ss.formula.udf">UDFFinder</a>&nbsp;toopack)</pre>
<div class="block">Register a new toolpack in this workbook.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#addToolPack(org.apache.poi.ss.formula.udf.UDFFinder)">addToolPack</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>toopack</code> - the toolpack to register</dd></dl>
</li>
</ul>
<a name="setForceFormulaRecalculation(boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForceFormulaRecalculation</h4>
<pre>public&nbsp;void&nbsp;setForceFormulaRecalculation(boolean&nbsp;value)</pre>
<div class="block">Whether the application shall perform a full recalculation when the workbook is opened.
 <p>
 Typically you want to force formula recalculation when you modify cell formulas or values
 of a workbook previously created by Excel. When set to true, this flag will tell Excel
 that it needs to recalculate all formulas in the workbook the next time the file is opened.
 </p>
 <p>
 Note, that recalculation updates cached formula results and, thus, modifies the workbook.
 Depending on the version, Excel may prompt you with "Do you want to save the changes in <em>filename</em>?"
 on close.
 </p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#setForceFormulaRecalculation(boolean)">setForceFormulaRecalculation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - true if the application will perform a full recalculation of
 workbook values when the workbook is opened</dd><dt><span class="strong">Since:</span></dt>
  <dd>3.8</dd></dl>
</li>
</ul>
<a name="getForceFormulaRecalculation()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForceFormulaRecalculation</h4>
<pre>public&nbsp;boolean&nbsp;getForceFormulaRecalculation()</pre>
<div class="block">Whether Excel will be asked to recalculate all formulas when the  workbook is opened.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html#getForceFormulaRecalculation()">getForceFormulaRecalculation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/poi/ss/usermodel/Workbook.html" title="interface in org.apache.poi.ss.usermodel">Workbook</a></code></dd>
<dt><span class="strong">Since:</span></dt>
  <dd>3.8</dd></dl>
</li>
</ul>
<a name="changeExternalReference(java.lang.String, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeExternalReference</h4>
<pre>public&nbsp;boolean&nbsp;changeExternalReference(java.lang.String&nbsp;oldUrl,
                              java.lang.String&nbsp;newUrl)</pre>
<div class="block">Changes an external referenced file to another file.
 A formular in Excel which refers a cell in another file is saved in two parts:
 The referenced file is stored in an reference table. the row/cell information is saved separate.
 This method invokation will only change the reference in the lookup-table itself.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>oldUrl</code> - The old URL to search for and which is to be replaced</dd><dd><code>newUrl</code> - The URL replacement</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the oldUrl was found and replaced with newUrl. Otherwise false</dd></dl>
</li>
</ul>
<a name="getRootDirectory()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRootDirectory</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;getRootDirectory()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HSSFWorkbook.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hssf/usermodel/HSSFTextbox.html" title="class in org.apache.poi.hssf.usermodel"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hssf/usermodel/HSSFWorkbook.html" target="_top">FRAMES</a></li>
<li><a href="HSSFWorkbook.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
